Use the Toggle Button 2D node to create a 2D UI control that the user can interact with through clicking, tapping, or pressing a keyboard key, and that has multiple toggle states. More...

#include <kanzi/ui/node/toggle_button2d.hpp>

Inheritance diagram for kanzi::ToggleButton2D:

[legend]

Public Types
using	ConceptClass

Public Types inherited from kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >
using	ToggleButtonGroup

Static Public Member Functions
static ToggleButton2DSharedPtr	create (Domain *domain, string_view name)
	Creates a toggle button node.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ClickConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::ButtonConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Protected Member Functions
Vector2	measureOverride (Vector2 availableSize) override
	Node2D::measureOverride implementation().

	ToggleButton2D (Domain *domain, string_view name)
	Constructor.

Protected Member Functions inherited from kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >
	ButtonConceptImpl (Domain *domain, string_view name)

void	initialize ()

void	onAttached () override

void	onClick (ClickManipulator::ClickMessageArguments &)

void	onClickBegin (ClickManipulator::ClickBeginMessageArguments &)

void	onClickCancel (ClickManipulator::ClickCancelMessageArguments &)

void	onClickEnter (ClickManipulator::ClickEnterMessageArguments &)

void	onClickLeave (ClickManipulator::ClickLeaveMessageArguments &)

void	onDetached () override

void	onKeyCancel (KeyManipulator::KeyCanceledMessageArguments &arguments)

void	onKeyDown (KeyManipulator::KeyPressedMessageArguments &arguments)

void	onKeyUp (KeyManipulator::KeyReleasedMessageArguments &arguments)

void	onLongPress (LongPressManipulator::LongPressMessageArguments &arguments)

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override

void	repeatHandler ()

Protected Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
	ClickConceptImpl (Domain *domain, string_view name)
	Constructor.

void	configureDoubleClick ()
	Configures a MultiClickManipulator for an ClickConcept-derived class based on the value of the DoubleClickEnabledProperty:

void	onAttached () override
	Overrides TBaseClass::onAttached().

void	onClicked (ClickManipulator::ClickMessageArguments &messageArguments)
	Handles click event.

void	onDetached () override
	Overrides TBaseClass::onDetached().

void	onMultiClicked (MultiClickManipulator::MultiClickMessageArguments &messageArguments)
	Handles multi-click event.

void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Overrides TBaseClass::onNodePropertyChanged().

Additional Inherited Members
Public Member Functions inherited from kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >
float	getAutoClickInterval () const

optional< size_t >	getEffectiveButtonGroupIndex () const
	Returns the index that Kanzi assigned to the Button when it was registered to a Toggle Button Group.

int	getIndexInGroup () const
	Returns the value of IndexInGroupProperty.

float	getLongPressInterval () const

unsigned int	getToggleState () const
	Returns the value of ToggleStateProperty.

unsigned int	getToggleStateCount () const
	Returns the value of ToggleStateCountProperty.

bool	isCurrentlyRegistered () const
	Returns whether the Button is registered to a Toggle Button Group.

bool	isPressed () const

bool	isPressOnHover () const

void	setAutoClickInterval (float value)

void	setIndexInGroup (int value)
	Sets the value of IndexInGroupProperty.

void	setLongPressInterval (float value)

void	setPressed (bool value)

void	setPressOnHover (bool value)

void	setToggleState (unsigned int state)
	Sets the value of ToggleStateProperty.

void	setToggleStateCount (unsigned int value)
	Sets the value of ToggleStateCountProperty.

void	toggle ()
	Toggles the button.

Public Member Functions inherited from kanzi::ClickConceptImpl< TBaseClass, TDerivedClass >
bool	isDoubleClickEnabled () const
	Gets the value of DoubleClickEnabledProperty.

void	setDoubleClickEnabled (bool value)
	Sets the value of DoubleClickEnabledProperty.

Static Public Attributes inherited from kanzi::ClickConcept
static PropertyType< bool >	DoubleClickEnabledProperty
	Enables the double-click gesture for a node.

Static Public Attributes inherited from kanzi::ButtonConcept
static PropertyType< bool >	IsPressedProperty
	Indicates whether the button is in the down state.

static PropertyType< float >	LongPressIntervalProperty
	Sets the amount of time in milliseconds that the user must hold the button pressed down for Kanzi to recognize it as a long-press gesture.

static PropertyType< bool >	PressOnHoverProperty
	Indicates whether hovering the pointer over the button sets the button in the down state.

static PropertyType< float >	AutoClickIntervalProperty
	Sets the time in milliseconds after which a button that the user keeps pressed down sends the ButtonConcept::ClickedMessage.

static PropertyType< int >	ToggleStateProperty
	Sets the toggle state of a Button.

static PropertyType< int >	ToggleStateCountProperty
	Sets the number of toggle states of a Button.

static PropertyType< int >	IndexInGroupProperty
	Sets the predefined index of a Button in the Toggle Button Group to which that Button is registered.

static MessageType< ClickedMessageArguments >	ClickedMessage

static MessageType< PressedMessageArguments >	PressedMessage

static MessageType< CanceledMessageArguments >	CanceledMessage

static MessageType< PointerEnteredMessageArguments >	PointerEnteredMessage

static MessageType< PointerLeftMessageArguments >	PointerLeftMessage

static MessageType< LongPressMessageArguments >	LongPressMessage

static MessageType< ToggledOnMessageArguments >	ToggledOnMessage

static MessageType< ToggledOffMessageArguments >	ToggledOffMessage

static MessageType< ToggleStateChangedMessageArguments >	ToggleStateChangedMessage

Static Protected Member Functions inherited from kanzi::ButtonConcept
static Vector2	measure2D (Node2D *button, Vector2 availableSize)
	Measure function for a Node2D button.

Protected Attributes inherited from kanzi::ClickConcept
ClickManipulatorSharedPtr	m_clickManipulator
	The ClickManipulator.

MultiClickManipulatorSharedPtr	m_multiClickManipulator
	Multi-Click manipulator.

Detailed Description

Use the Toggle Button 2D node to create a 2D UI control that the user can interact with through clicking, tapping, or pressing a keyboard key, and that has multiple toggle states.

Member Typedef Documentation

◆ ConceptClass

using kanzi::ToggleButton2D::ConceptClass

Constructor & Destructor Documentation

◆ ToggleButton2D()

kanzi::ToggleButton2D::ToggleButton2D	(	Domain *	domain,
		string_view	name )

explicitprotected

Constructor.

Parameters

domain	The UI domain the new node belongs to.
name	The name of the node.

Member Function Documentation

◆ create()

static ToggleButton2DSharedPtr kanzi::ToggleButton2D::create	(	Domain *	domain,
		string_view	name )

static

Creates a toggle button node.

Parameters

domain	The UI domain to which the new node belongs.
name	The name of the node.

Returns: The created node.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::ToggleButton2D::makeEditorInfo ( )

static

◆ measureOverride()

Vector2 kanzi::ToggleButton2D::measureOverride ( Vector2 availableSize )

inlineoverrideprotected

Node2D::measureOverride implementation().

The documentation for this class was generated from the following file:

kanzi/ui/node/toggle_button2d.hpp

Public Types

Static Public Member Functions

Protected Member Functions

Additional Inherited Members